/*
 * Copyright [2019] [恒宇少年 - 于起宇]
 *
 *      Licensed under the Apache License, Version 2.0 (the "License");
 *      you may not use this file except in compliance with the License.
 *      You may obtain a copy of the License at
 *
 *          http://www.apache.org/licenses/LICENSE-2.0
 *
 *      Unless required by applicable law or agreed to in writing, software
 *      distributed under the License is distributed on an "AS IS" BASIS,
 *      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *      See the License for the specific language governing permissions and
 *      limitations under the License.
 *
 */

package org.minbox.framework.api.boot.push;

import org.minbox.framework.api.boot.common.exception.ApiBootException;
import org.minbox.framework.api.boot.push.model.MessagePushBody;
import org.minbox.framework.api.boot.push.model.PushClientConfig;

/**
 * ApiBoot Message Push Service
 *
 * @author 恒宇少年
 */
public interface ApiBootMessagePushService {
    /**
     * execute push message
     *
     * @param messagePushBody request body
     * @throws ApiBootException ApiBoot Exception
     */
    void executePush(MessagePushBody messagePushBody) throws ApiBootException;

    /**
     * get current thread push client name
     *
     * @return push client name
     * @throws ApiBootException ApiBoot Exception
     */
    String getCurrentPushClientName() throws ApiBootException;

    /**
     * get current thread push client
     *
     * @return push message client
     * @throws ApiBootException ApiBoot Exception
     */
    PushClientConfig getCurrentPushClient() throws ApiBootException;
}
